getSongInfo

Returns information about a specific list of songs.

Sample Request

<mmRequest command="getSongInfo" station="ID" [version="1"] [client=""] [userData=""]>
	<contents>
		<songList>
			<song [songId="1"] [cutId="x"] [catID="1"] [category="A"] />
		</songList>
		[<fields>
			<field id="101" />
			<field name="Title" />
		</fields>]
	</contents>
</mmRequest>

Request Notes

The list of songs to include must be specifically included in the songList tag with one song tag for each song you want to include.

 

The cutID attribute will only be returned if a cutID has been defined in the Nexus configuration.

 

The fields section must contain one field tag for each song field you wish to include in the reply message. You can use the id attribute with the internal field ID codes, or a name attribute with the user-specified field name. Only the specified fields will be returned for each song. You can obtain a list of available fields with the command. See Appendix C - Song Field Request Options for addition options that can be used with your fields specification.

 

Note that the fields section is optional. If not specified, this command will return all available fields.

 

You can also specify the category so when a song is in more than one category, you can target the specific instance you wish to work with. You can do this either by category ID (available via getCategoryList) or by the actual user category code.

Sample Reply

<mmReply command="getSongInfo" userData="hello" status="ok">
	<contents>
		<songList recordCount="1">
			<song songId="239">
				<field id="100" name="">BEATLES / THE LONG AND WINDING ROAD</field>
				<field id="102" name="Artist">BEATLES</field>
			</song>
		</songList>
	</contents>
</mmReply>

The songID will always appear as shown. If the cutID is defined, it will also show on that line.

Reply Notes

The list of songs is returned in the contents/songlist section. Each song has a song tag. The songId attribute contains the MusicMaster internal song ID for each song. One or more field tags may be included with the value of each requested field. The field tags include an id attribute with the internal field ID number and a name attribute with the user defined field name.

 

The list will be returned whether or not any invalid songs were specified, even if the list contains zero songs. When any invalid songs are specified, the status will return as 'error' and an error message will also be included in the reply.

Compatibility and Version Info

Available in all versions